<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_hdmitxss: video_prbs_genchk_drv.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hdmitxss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('video__prbs__genchk__drv_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">video_prbs_genchk_drv.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the driver implementation for the Video PRBS generator and checker used in the HDMI example design. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
<hr/>

X.XX  XX  YYYY/MM/DD   ...
1.00  RHe 2015/05/08   First release
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a6dd2641484d163bcd31de9d8313248ee"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="video__prbs__genchk__drv_8c.html#a6dd2641484d163bcd31de9d8313248ee">XVideoPRBSGenChk_Init</a> (XVideoPRBSGenChk_t *InstancePtr, u32 PRBSGenChkBase)</td></tr>
<tr class="memdesc:a6dd2641484d163bcd31de9d8313248ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the Video PRBS Generator/Checker.  <a href="#a6dd2641484d163bcd31de9d8313248ee">More...</a><br /></td></tr>
<tr class="separator:a6dd2641484d163bcd31de9d8313248ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac12faa619430b22e213b7c06860c0f66"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="video__prbs__genchk__drv_8c.html#ac12faa619430b22e213b7c06860c0f66">XVideoPRBSGenChk_Enable</a> (XVideoPRBSGenChk_t *InstancePtr, u8 setclr)</td></tr>
<tr class="memdesc:ac12faa619430b22e213b7c06860c0f66"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the Generator/Checker.  <a href="#ac12faa619430b22e213b7c06860c0f66">More...</a><br /></td></tr>
<tr class="separator:ac12faa619430b22e213b7c06860c0f66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac460c46e4476cb392e398efc9b1156de"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="video__prbs__genchk__drv_8c.html#ac460c46e4476cb392e398efc9b1156de">XVideoPRBSGenChk_SetPixCfg</a> (XVideoPRBSGenChk_t *InstancePtr, XVidC_PixelsPerClock PixPerClk)</td></tr>
<tr class="memdesc:ac460c46e4476cb392e398efc9b1156de"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the pixel configuration.  <a href="#ac460c46e4476cb392e398efc9b1156de">More...</a><br /></td></tr>
<tr class="separator:ac460c46e4476cb392e398efc9b1156de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a50dc3c7a7f1603cf5b9034f84d770b3c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="video__prbs__genchk__drv_8c.html#a50dc3c7a7f1603cf5b9034f84d770b3c">XVideoPRBSGenChk_SetBpcCfg</a> (XVideoPRBSGenChk_t *InstancePtr, XVidC_ColorDepth BitsPerColor)</td></tr>
<tr class="memdesc:a50dc3c7a7f1603cf5b9034f84d770b3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the bits per color configuration.  <a href="#a50dc3c7a7f1603cf5b9034f84d770b3c">More...</a><br /></td></tr>
<tr class="separator:a50dc3c7a7f1603cf5b9034f84d770b3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a627a0220ea13c0329d17cd723f7d8939"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="video__prbs__genchk__drv_8c.html#a627a0220ea13c0329d17cd723f7d8939">XVideoPRBSGenChk_GetErrCnt</a> (XVideoPRBSGenChk_t *InstancePtr)</td></tr>
<tr class="memdesc:a627a0220ea13c0329d17cd723f7d8939"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the pixel error count from the checker.  <a href="#a627a0220ea13c0329d17cd723f7d8939">More...</a><br /></td></tr>
<tr class="separator:a627a0220ea13c0329d17cd723f7d8939"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5825015bedfa2239b37b5b38ec6022"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="video__prbs__genchk__drv_8c.html#a1c5825015bedfa2239b37b5b38ec6022">XVideoPRBSGenChk_ClrErrCnt</a> (XVideoPRBSGenChk_t *InstancePtr)</td></tr>
<tr class="memdesc:a1c5825015bedfa2239b37b5b38ec6022"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the pixel error count for the checker.  <a href="#a1c5825015bedfa2239b37b5b38ec6022">More...</a><br /></td></tr>
<tr class="separator:a1c5825015bedfa2239b37b5b38ec6022"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a1c5825015bedfa2239b37b5b38ec6022"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c5825015bedfa2239b37b5b38ec6022">&#9670;&nbsp;</a></span>XVideoPRBSGenChk_ClrErrCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVideoPRBSGenChk_ClrErrCnt </td>
          <td>(</td>
          <td class="paramtype">XVideoPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function clears the pixel error count for the checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVideoPRBSGenChk_t core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>

<p class="reference">References <a class="el" href="video__prbs__genchk__drv_8h.html#a1877f73f40a089a4ccf1ef7afaf69094">XVideo_PRBS_GenChk_WriteReg</a>.</p>

</div>
</div>
<a id="ac12faa619430b22e213b7c06860c0f66"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac12faa619430b22e213b7c06860c0f66">&#9670;&nbsp;</a></span>XVideoPRBSGenChk_Enable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVideoPRBSGenChk_Enable </td>
          <td>(</td>
          <td class="paramtype">XVideoPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>setclr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables the Generator/Checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVideoPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">setclr</td><td>specifies TRUE/FALSE value to either assert or release Generator/Checker reset.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="video__prbs__genchk__drv_8h.html#a3923c5dba075672f8311be3adebc274e">XVideo_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="a627a0220ea13c0329d17cd723f7d8939"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a627a0220ea13c0329d17cd723f7d8939">&#9670;&nbsp;</a></span>XVideoPRBSGenChk_GetErrCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XVideoPRBSGenChk_GetErrCnt </td>
          <td>(</td>
          <td class="paramtype">XVideoPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the pixel error count from the checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVideoPRBSGenChk_t core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of pixel errors found</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The count value does not wrap after reaching 0xFFFFFFFF. </dd></dl>

<p class="reference">References <a class="el" href="video__prbs__genchk__drv_8h.html#a3923c5dba075672f8311be3adebc274e">XVideo_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="a6dd2641484d163bcd31de9d8313248ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6dd2641484d163bcd31de9d8313248ee">&#9670;&nbsp;</a></span>XVideoPRBSGenChk_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVideoPRBSGenChk_Init </td>
          <td>(</td>
          <td class="paramtype">XVideoPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>PRBSGenChkBase</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the Video PRBS Generator/Checker. </p>
<p>This function must be called prior to using the Generator/Checker.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVideoPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">PRBSGenChkBase</td><td>is the base address for the core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a id="a50dc3c7a7f1603cf5b9034f84d770b3c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50dc3c7a7f1603cf5b9034f84d770b3c">&#9670;&nbsp;</a></span>XVideoPRBSGenChk_SetBpcCfg()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVideoPRBSGenChk_SetBpcCfg </td>
          <td>(</td>
          <td class="paramtype">XVideoPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_ColorDepth&#160;</td>
          <td class="paramname"><em>BitsPerColor</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the bits per color configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVideoPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">BitsPerColor</td><td>specifies the number of bits per color component per pixel.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful.</li>
<li>XST_FAILURE if invalid bits per color configuration is requested.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="video__prbs__genchk__drv_8h.html#a3923c5dba075672f8311be3adebc274e">XVideo_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="ac460c46e4476cb392e398efc9b1156de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac460c46e4476cb392e398efc9b1156de">&#9670;&nbsp;</a></span>XVideoPRBSGenChk_SetPixCfg()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XVideoPRBSGenChk_SetPixCfg </td>
          <td>(</td>
          <td class="paramtype">XVideoPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">XVidC_PixelsPerClock&#160;</td>
          <td class="paramname"><em>PixPerClk</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the pixel configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XVideoPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">PixPerClk</td><td>specifies the number of pixels per clock.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful.</li>
<li>XST_FAILURE if invalid pixel configuration is requested.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="video__prbs__genchk__drv_8h.html#a3923c5dba075672f8311be3adebc274e">XVideo_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
